Api.ReadInputByte method

Reads a byte from an input of a real or simulated I/O module.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsReturn<byte> ReadInputByte(
       int Index,
       int ByteOffset
)

Public Function ReadInputByte(
       Index As Integer,
       ByteOffset As Integer
) As KsReturn(Of Byte)

Parameters

Index

Type: int

The index of an I/O module. Indexes are zero based. Aliases affect this parameter.

ByteOffset

Type: int

Specifies a byte offset to the location to read a byte value. The max offset is determined by InputLength in the SlaveStatus class.

Return value

Returns a KsError code and a byte value.

Remarks

ReadInputByte can only be called once a link is established and started.

Usable EtherCAT states

ecatOP

Examples

N/A